|
Eclipse Platform Pre-release 3.0 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
An instance of IKeyConfiguration
is a handle representing a
key configuration as defined by the extension point org.eclipse.ui.commands
.
The identifier of the handle is identifier of the key configuration being
represented.
An instance of IKeyConfiguration
can be obtained from an
instance of ICommandManager
for any identifier, whether or
not a key configuration with that identifier defined in the plugin registry.
The handle-based nature of this API allows it to work well with runtime plugin activation and deactivation, which causes dynamic changes to the plugin registry, and therefore, potentially, dynamic changes to the set of key configuration definitions.
This interface is not intended to be extended or implemented by clients.
EXPERIMENTAL
IKeyConfigurationListener
,
ICommandManager
Method Summary | |
void |
addKeyConfigurationListener(IKeyConfigurationListener keyConfigurationListener)
Registers an instance of IKeyConfigurationListener to
listen for changes to attributes of this instance. |
String |
getDescription()
Returns the description of the key configuration represented by this handle, suitable for display to the user. |
String |
getId()
Returns the identifier of this handle. |
String |
getName()
Returns the name of the key configuration represented by this handle, suitable for display to the user. |
String |
getParentId()
Returns the identifier of the parent of the key configuration represented by this handle. |
boolean |
isActive()
Returns whether or not this command is active. |
boolean |
isDefined()
Returns whether or not the key configuration represented by this handle is defined. |
void |
removeKeyConfigurationListener(IKeyConfigurationListener keyConfigurationListener)
Unregisters an instance of IKeyConfigurationListener
listening for changes to attributes of this instance. |
Methods inherited from interface java.lang.Comparable |
compareTo |
Method Detail |
public void addKeyConfigurationListener(IKeyConfigurationListener keyConfigurationListener)
IKeyConfigurationListener
to
listen for changes to attributes of this instance.
keyConfigurationListener
- the instance of IKeyConfigurationListener
to
register. Must not be null
. If an attempt is
made to register an instance of IKeyConfigurationListener
which is already registered with this instance, no operation
is performed.public String getDescription() throws NotDefinedException
Returns the description of the key configuration represented by this handle, suitable for display to the user.
Notification is sent to all registered listeners if this attribute changes.
null
.
NotDefinedException
- if the key configuration represented by this handle is not
defined.public String getId()
null
.public String getName() throws NotDefinedException
Returns the name of the key configuration represented by this handle, suitable for display to the user.
Notification is sent to all registered listeners if this attribute changes.
null
.
NotDefinedException
- if the key configuration represented by this handle is not
defined.public String getParentId() throws NotDefinedException
Returns the identifier of the parent of the key configuration represented by this handle.
Notification is sent to all registered listeners if this attribute changes.
null
.
NotDefinedException
- if the key configuration represented by this handle is not
defined.public boolean isActive()
Returns whether or not this command is active. Instances of ICommand
are activated and deactivated by the instance of ICommandManager
from whence they were brokered.
Notification is sent to all registered listeners if this attribute changes.
true
, iff this command is active.public boolean isDefined()
Returns whether or not the key configuration represented by this handle is defined.
Notification is sent to all registered listeners if this attribute changes.
true
, iff the key configuration represented by
this handle is defined.public void removeKeyConfigurationListener(IKeyConfigurationListener keyConfigurationListener)
IKeyConfigurationListener
listening for changes to attributes of this instance.
keyConfigurationListener
- the instance of IKeyConfigurationListener
to
unregister. Must not be null
. If an attempt
is made to unregister an instance of IKeyConfigurationListener
which is not already registered with this instance, no
operation is performed.
|
Eclipse Platform Pre-release 3.0 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |